/*
 * Copyright 2014-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package example.springdata.mongodb.advanced;

import java.util.List;

import org.springframework.data.mongodb.repository.Meta;

import example.springdata.mongodb.customer.Customer;
import example.springdata.mongodb.customer.CustomerRepository;

/**
 * Repository interface to manage {@link Customer} instances.
 *
 * @author Christoph Strobl
 */
public interface AdvancedRepository extends CustomerRepository {

	String META_COMMENT = "s2gx-2014-rocks!";

	/**
	 * Derived query using {@code $comment} meta attribute for quick lookup. <br />
	 * Have a look at the {@literal mongodb shell} and execute:
	 *
	 * <pre>
	 * <code>
	 *  db['system.profile'].find({'query.$comment':'s2gx-2014-rocks!'})
	 * </code>
	 * </pre>
	 *
	 * @param firstname
	 * @return
	 */
	@Meta(comment = META_COMMENT)
	List<Customer> findByFirstname(String firstname);
}
